import { get, post, postWithQueryParams } from "@/api/request";

/**
 * 参数控制器 / 参数控制器添加
 * @param {object} data
 * @param {string} [data.paramKey] 键名（英文标识）
 * @param {string} [data.paramName] 参数名称（中文描述）
 * @param {string} [data.paramValue] 键值
 * @param {string} [data.remark] 备注
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<number>}
 * @author 方昊
 */
export function systemParamAdd(data, config) {
  return post("/system/param/add", data, config);
}

/**
 * 参数控制器 / 参数控制器删除
 * @param {object} params
 * @param {object} data
 * @param {number} params.id 参数ID
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<number>}
 * @author 方昊
 */
export function systemParamDelete(params, data, config) {
  return postWithQueryParams("/system/param/delete", params, data, config);
}

/**
 * 参数控制器 / 参数控制器查询详情
 * @param {object} params
 * @param {number} params.id 参数ID
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<Param页面展示实体>}
 * @author 方昊
 */
export function systemParamDetail(params, config) {
  return get("/system/param/detail", params, config);
}

/**
 * 参数控制器 / 参数控制器分页查询
 * @param {object} data
 * @param {number} [data.length] 分页大小
 * @param {number} [data.orderAsc] 排序方向
 * @param {string} [data.orderColum] 排序字段
 * @param {number} [data.pageIndex] 分页下标
 * @param {string} [data.paramName] 参数名称（中文描述）
 * @param {number} [data.start] 查询记录起始下标
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<分页返回实体<Param页面展示实体>>}
 * @author 方昊
 */
export function systemParamList(data, config) {
  return post("/system/param/list", data, config);
}

/**
 * 参数控制器 / 参数控制器更新
 * @param {object} data
 * @param {number} [data.id] 主键
 * @param {string} [data.paramKey] 键名（英文标识）
 * @param {string} [data.paramName] 参数名称（中文描述）
 * @param {string} [data.paramValue] 键值
 * @param {string} [data.remark] 备注
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<Param页面展示实体>}
 * @author 方昊
 */
export function systemParamUpdate(data, config) {
  return post("/system/param/update", data, config);
}

/**
 * 参数控制器 / 参数控制器查询参数值
 * @param {object} params
 * @param {string} params.paramKey 参数键
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<Param页面展示实体>}
 * @author 方昊
 */
export function systemParamValue(params, config) {
  return get("/system/param/value", params, config);
}

/**
 * 参数控制器 / 参数控制器查询参数值
 * @param {object} data
 * @param {array<string>} data.paramKey paramKey
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<Param页面展示实体>}
 * @author 李居帅
 */
export function systemParamValueList(data, config) {
  return post("/system/param/value/list", data, config);
}

/**
 * @template T
 * @typedef {Object} 分页返回实体
 * @property {T[]} content - 内容
 * @property {number} elementsNo
 * @property {number} limit
 * @property {number} number
 * @property {number} totalElements
 * @property {number} totalPages
 * @description 分页返回实体
 */

/**
 * @typedef {object} Param页面展示实体 页面展示实体
 * @property {boolean} canDelete 是否拥有删除权限
 * @property {boolean} canEdit 是否拥有编辑权限
 * @property {string} createTime 创建时间
 * @property {string} createUser 创建用户
 * @property {string} createUserDeptName 创建人所属部门
 * @property {string} createUserRealName 创建人真实姓名
 * @property {boolean} delFlag 删除标识(false:否, true:是)
 * @property {string} id 主键
 * @property {string} paramKey 键名（英文标识）
 * @property {string} paramName 参数名称（中文描述）
 * @property {string} paramValue 键值
 * @property {string} remark 备注
 * @description 页面展示实体
 */
